/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.antgroup.geaflow.cluster.collector;

import java.io.Serializable;

public interface IEmitterRequest extends Serializable {

    /**
     *  Return the task id of the emitter request.
     *
     * @return task id.
     */
    int getTaskId();

    /**
     * Return the window id of the emitter request.
     *
     * @return window id.
     */
    long getWindowId();

    /**
     * Return the request type of the emitter request.
     *
     * @return request type.
     */
    RequestType getRequestType();

    enum RequestType {

        /**
         * Init request.
         */
        INIT,
        /**
         * Close request.
         */
        CLOSE,

        /**
         * Stash request.
         */
        STASH,
        /**
         * Pop request, update the request when cached.
         */
        POP,
        /**
         * Clear the init emitter request in cache.
         */
        CLEAR

    }

}
